package cn.iocoder.yudao.module.datasource.service.config;

import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.module.datasource.controller.admin.config.vo.DataSourceConfigPageReqVO;
import cn.iocoder.yudao.module.datasource.controller.admin.config.vo.DataSourceConfigSaveReqVO;
import cn.iocoder.yudao.module.datasource.dal.dataobject.config.DynamicDataSourceConfigDO;

import javax.validation.Valid;
import java.util.List;

/**
 * 数据源配置 Service 接口
 *
 * @author 芋道源码
 */
public interface DataSourceConfigService {

    /**
     * 创建数据源配置
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    Long createDataSourceConfig(@Valid DataSourceConfigSaveReqVO createReqVO);

    /**
     * 更新数据源配置
     *
     * @param updateReqVO 更新信息
     */
    void updateDataSourceConfig(@Valid DataSourceConfigSaveReqVO updateReqVO);

    /**
     * 删除数据源配置
     *
     * @param id 编号
     */
    void deleteDataSourceConfig(Long id);

    /**
     * 获得数据源配置
     *
     * @param id 编号
     * @return 数据源配置
     */
    DynamicDataSourceConfigDO getDataSourceConfig(Long id);

    /**
     * 获得数据源配置分页
     *
     * @param pageReqVO 分页查询
     * @return 数据源配置分页
     */
    PageResult<DynamicDataSourceConfigDO> getDataSourceConfigPage(DataSourceConfigPageReqVO pageReqVO);

    /**
     * 获得数据源配置列表, 用于 Excel 导出
     *
     * @param exportReqVO 查询条件
     * @return 数据源配置列表
     */
    List<DynamicDataSourceConfigDO> getDataSourceConfigList(DataSourceConfigPageReqVO exportReqVO);

    /**
     * 获得启用的数据源配置列表
     *
     * @return 数据源配置列表
     */
    List<DynamicDataSourceConfigDO> getEnabledDataSourceConfigList();

    /**
     * 测试数据源连接
     *
     * @param id 数据源配置编号
     * @return 是否连接成功
     */
    boolean testConnection(Long id);

    /**
     * 测试数据源连接
     *
     * @param config 数据源配置
     * @return 是否连接成功
     */
    boolean testConnection(DynamicDataSourceConfigDO config);

}